SREG V2 MANUAL - By Alex
==============


GLOBAL VARIABLES:
-----------------
Description: Your app/game must contain the following global variables for SREG to be functional.

global.title  // Title of your app/game
global.author // Author of the app/game
gloal.version // Version of the app/game


BASIC FUNCTIOINS:
-----------------
Description: Basic functions generate/verify serial codes which can be used on multiple computers.

	     PLEASE NOTE: basic serial keys and secure serial keys are NOT compatible with eachother


sreg_basic_create()
	Description: Generates a serial code.

	Argument0: Username (client)
	Argument1: Password (app/game)
	Returns: Serial code (string)


sreg_basic_verify()
	Description: Verifies serial

	Argument0: Username
	Argument1: Serial
	Argument2: Password
	Returns: true (if valid), else returns false (bool)


sreg_basic_convert()
	Description: Converts a specified serial to a current serial (useful for when updating app/game)

	Argument0: Username
	Argument1: Serial
	Argument2: Version (used in serial)
	Argument3: Password (used in serial)
	Returns: New serial (if valid), else returns error (string)


SECURE FUNCTIONS:
-----------------
Description: Secure functions generate/verify serial codes based on a Request_Code. 
	     The user will need to give you their desires Username and their Request_Code in order
	     to obtain a working serial.

	     Serials generated using secure functions will ONLY be operational on the
	     computer that the Request_Code came from, hence, users will not be able to distribute
	     their serial or use it on more than one computer.

	     PLEASE NOTE: basic serial keys and secure serial keys are NOT compatible with eachother


sreg_secure_request()
	Description: Generates a Request_Code.
	WARNING: Request_Code MUST be generated through the client/users computer.

	Argument0: Username
	Argument1: Password
	Returns: Request_Code (string).


sreg_secure_create()
	Description: Generates a serial code based on the users Request_Code.           

 	Argument0: Username
	Argument1: Request_Code
	Argument2: Password
	Returns: Serial code


sreg_secure_verify()
	Description: Verify serial code (client/user based)
	
	Argument0: Username
	Argument1: Serial
	Argument2: Password
	Returns: true (if valid), else returns false (bool)

sreg_secure_convert()
	Description: Converts a specified serial to a current serial (useful for when updating app/game)

	Argument0: Username
	Argument1: Request_Code
	Argument2: Serial
	Argument3: Version
	Argument4: Password
	Returns: New serial (if valid), else returns error (string)


License:
--------
Credit is optional. You may use SREG in both free and commercial applications/games. You may not sell the registration system on it's own however.
If you decide to use SREG in a distributed-registration-system of your own, credit MUST be added.



